GetBytes(Int32,Int64,Byte[],Int32,Int32) Method

In This Topic

Reads a stream of bytes from the specified column offset into the buffer as an array starting at the given buffer offset.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Overrides Function GetBytes( _
   ByVal ordinal As Integer, _
   ByVal fieldOffset As Long, _
   ByVal buffer() As Byte, _
   ByVal bufferOffset As Integer, _
   ByVal length As Integer _
) As Long

public override long GetBytes( 
   int ordinal,
   long fieldOffset,
   byte[] buffer,
   int bufferOffset,
   int length
)

Parameters

ordinal: The zero-based column ordinal.
fieldOffset: The index within the field where the read operation is to begin.
buffer: The buffer into which to read the stream of bytes.
bufferOffset: The index where buffer is to begin the write operation.
length: The maximum length to copy into the buffer.

Return Value

The actual number of bytes read.

Remarks

GetBytes returns the number of available bytes in the field. In most cases this is the exact length of the field. However, the number returned may be less than the true length of the field if GetBytes has already been used to obtain bytes from the field. This may be the case, for example, if the DbDataReaderBase is reading a large data structure into a buffer.

If you pass a buffer that is a null value, GetBytes returns the length of the field in bytes.

Reference

DbDataReaderBase Class
DbDataReaderBase Members
Overload List

Send Feedback